Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Automatically build TypeDoc and Storybook in CI #2450

Merged
merged 1 commit into from
Dec 28, 2024

Conversation

henrycatalinismith
Copy link
Collaborator

@henrycatalinismith henrycatalinismith commented Dec 27, 2024

Following up on #2092. I've added the docs:build package script almost as described in your suggestion (corrected the output directory flag a little bit). Both looking good after running that command. The redirects are working great too. These screenshots are after running yarn docs:build, yarn build, and finally yarn start.

TypeDoc Storybook
Screenshot 2024-12-27 at 16 38 21 Screenshot 2024-12-27 at 16 38 26

This only deviates from your suggested diff in one other way that I'm aware of, which is that I also cut the build-storybook package script. I ditched it cos I don't think it's being used and because it outputs its build into a different directory. Reckon if we end up with use cases for individual package scripts for these later down the line, maybe we want to think about having something like docs:build-all, docs:build-storybook etc, and have the "all" build call the individual ones. But until then, maybe it's best to just cut the bloat?

Copy link
Member

@richardolsson richardolsson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cool! I reconfigured the deployment and the latest automatic preview build is now live here:

Since this is using a new script, this will not affect the production build, which will not expose docs or storybook.

Nice work! Let's get this merged. 💯 🟢 🟢 🟢

@richardolsson richardolsson merged commit e73131c into main Dec 28, 2024
6 checks passed
@richardolsson richardolsson deleted the undocumented/deploy-typedoc-and-storybook branch December 28, 2024 16:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants